System Booster/System Booster.iso/Texteditors/Origami/bindings/fun/fillpara.r

Text File | 1996-09-27 | 2.7 KB | 102 lines

@ref-see-also See also in %s.
@{{{}}}
@{{{  fillpara-reference-file
@if-using ( complete )
@{{{  @fillpara-ref Description
@if-using ( complete )
This library offers the possibility, for automatic line break and block
reformating of text files.
@fi
@}}}
@fi
@if-using ( complete fill-para-called set-col-called set-mode-called wrap-called add-wrap-called delete-wrap-called )
@{{{  @fillpara-ref Functions and macros
@if-using ( complete fill-para-called )
@{{{  @fillpara-ref fill-paragraph
Fill all lines from cursor position to a end-of-block line.

@ref-start-item end-of-block:
@ref-start-item *
A line using nother indentation
@ref-end-item
@ref-start-item *
A line startting with the current begin-fold-comment string
@ref-end-item
@ref-start-item *
If fill mode shrink and language Roff are active, a line starting with `.'.
@ref-end-item
@ref-start-item *
If fill mode shrink and language Tex are active, a line starting with `\'.
@ref-start-item *
@ref-end-item
If language OCL (User:`;OCL',`') is active, a line starting with `@'.
@ref-end-item
@ref-end-item

If fill mode block is active, all but the last line are filled with spaces,
to match the right margin exactly. Tabs inside the filled region will be
replaced by spaces.
@}}}
@fi
@if-using ( complete set-col-called )
@{{{  @fillpara-ref set-fill-column
Define the right margin for fill-paragraph. The value is given by:

@ref-start-item
modify-behaviour, if greater then 0,
@ref-end-item
@ref-start-item or
by the value of repeat-argument,
@ref-end-item
@ref-start-item or
the cursor x position, if greater than 20,
@ref-end-item
@ref-start-item or
by your input (set-fill-column prompts for).
@ref-end-item
@}}}
@fi
@if-using ( complete set-mode-called )
@{{{  @fillpara-ref set-fill-column
Offers a menu, for selecting the fill mode (shrink or block) and the right
fill margin.
@}}}
@fi
@if-using ( complete wrap-called )
@{{{  @fillpara-ref wrap-word
Can be used to replace the single space.

If used at end of a line, behind the right fill margin, the last word
will be moved to the next line and a space will be added.

In front of fill margin and if mode wrap is not active, a single space
will be added.
@}}}
@fi
@if-using ( complete add-wrap-called )
@{{{  @fillpara-ref add-mode-wrap
Activate automatic line wrapping. Mark the mode with `Wrap' or `W' in
the statusline.
@}}}
@fi
@if-using ( complete delete-wrap-called )
@{{{  @fillpara-ref delete-mode-wrap
Switch of automatic line wrapping.
@}}}
@fi
@}}}
@fi
@if-using ( complete )
@{{{  @fillpara-ref Hooks
@if-using ( complete )
The library uses begin-prompt-macro and end-prompt-macro.

Defining the Tag FORCE-DOT-SPACES will always use 2 spaces after `.',
if block filling is not active.

The wrap-word macros are delared as demand-loading.
@fi
@}}}
@fi
@}}}